<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpprogress: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="libgimp3-gimpparamspecs.html" title="gimpparamspecs">
<link rel="next" href="libgimp3-gimpdebug.html" title="gimpdebug">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-gimpprogress.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp3-gimpparamspecs.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp3-gimpdebug.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-gimpprogress"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-gimpprogress.top_of_page"></a>gimpprogress</span></h2>
<p>gimpprogress — Functions for embedding the progress bar into a plug-in's GUI.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-gimpprogress.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableEndFunc" title="GimpProgressVtableEndFunc ()">*GimpProgressVtableEndFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint32</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableGetWindowFunc" title="GimpProgressVtableGetWindowFunc ()">*GimpProgressVtableGetWindowFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtablePulseFunc" title="GimpProgressVtablePulseFunc ()">*GimpProgressVtablePulseFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableSetTextFunc" title="GimpProgressVtableSetTextFunc ()">*GimpProgressVtableSetTextFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableSetValueFunc" title="GimpProgressVtableSetValueFunc ()">*GimpProgressVtableSetValueFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableStartFunc" title="GimpProgressVtableStartFunc ()">*GimpProgressVtableStartFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()">gimp_progress_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-init-printf" title="gimp_progress_init_printf ()">gimp_progress_init_printf</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-update" title="gimp_progress_update ()">gimp_progress_update</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-pulse" title="gimp_progress_pulse ()">gimp_progress_pulse</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-set-text" title="gimp_progress_set_text ()">gimp_progress_set_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-set-text-printf" title="gimp_progress_set_text_printf ()">gimp_progress_set_text_printf</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-end" title="gimp_progress_end ()">gimp_progress_end</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-get-window-handle" title="gimp_progress_get_window_handle ()">gimp_progress_get_window_handle</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-install-vtable" title="gimp_progress_install_vtable ()">gimp_progress_install_vtable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-uninstall" title="gimp_progress_uninstall ()">gimp_progress_uninstall</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-cancel" title="gimp_progress_cancel ()">gimp_progress_cancel</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpprogress.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtable" title="struct GimpProgressVtable">GimpProgressVtable</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpprogress.description"></a><h2>Description</h2>
<p>Functions for embedding the progress bar into a plug-in's GUI.</p>
</div>
<div class="refsect1">
<a name="libgimp3-gimpprogress.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GimpProgressVtableEndFunc"></a><h3>GimpProgressVtableEndFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpProgressVtableEndFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Ends the progress</p>
<div class="refsect3">
<a name="GimpProgressVtableEndFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GimpProgressVtableGetWindowFunc"></a><h3>GimpProgressVtableGetWindowFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">guint32</span>
<span class="c_punctuation">(</span>*GimpProgressVtableGetWindowFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<div class="refsect3">
<a name="GimpProgressVtableGetWindowFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="GimpProgressVtableGetWindowFunc.returns"></a><h4>Returns</h4>
<p> the ID of the window where the progress is displayed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GimpProgressVtablePulseFunc"></a><h3>GimpProgressVtablePulseFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpProgressVtablePulseFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Makes the progress pulse</p>
<div class="refsect3">
<a name="GimpProgressVtablePulseFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GimpProgressVtableSetTextFunc"></a><h3>GimpProgressVtableSetTextFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpProgressVtableSetTextFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>,
                                  <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Sets a new text on the progress.</p>
<div class="refsect3">
<a name="GimpProgressVtableSetTextFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>The new text</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GimpProgressVtableSetValueFunc"></a><h3>GimpProgressVtableSetValueFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpProgressVtableSetValueFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gdouble</span> percentage</code></em>,
                                   <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Sets a new percentage on the progress.</p>
<div class="refsect3">
<a name="GimpProgressVtableSetValueFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>percentage</p></td>
<td class="parameter_description"><p>The progress in percent</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GimpProgressVtableStartFunc"></a><h3>GimpProgressVtableStartFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpProgressVtableStartFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>,
                                <em class="parameter"><code><span class="type">gboolean</span> cancelable</code></em>,
                                <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Starts the progress</p>
<div class="refsect3">
<a name="GimpProgressVtableStartFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>The message to show</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancelable</p></td>
<td class="parameter_description"><p>Whether the procedure is cancelable</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-init"></a><h3>gimp_progress_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_init (<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>Initializes the progress bar for the current plug-in.</p>
<p>Initializes the progress bar for the current plug-in. It is only
valid to call this procedure from a plug-in.</p>
<div class="refsect3">
<a name="gimp-progress-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>Message to use in the progress dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-progress-init.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-init-printf"></a><h3>gimp_progress_init_printf ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_init_printf (<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
                           <em class="parameter"><code>...</code></em>);</pre>
<p>Initializes the progress bar for the current plug-in.</p>
<p>Initializes the progress bar for the current plug-in. It is only
valid to call this procedure from a plug-in.</p>
<div class="refsect3">
<a name="gimp-progress-init-printf.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a standard <code class="function">printf()</code> format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>arguments for <em class="parameter"><code>format</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-progress-init-printf.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-update"></a><h3>gimp_progress_update ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_update (<em class="parameter"><code><span class="type">gdouble</span> percentage</code></em>);</pre>
<p>Updates the progress bar for the current plug-in.</p>
<div class="refsect3">
<a name="gimp-progress-update.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>percentage</p></td>
<td class="parameter_description"><p>Percentage of progress completed (in the range from 0.0 to 1.0).</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-progress-update.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-pulse"></a><h3>gimp_progress_pulse ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_pulse (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Pulses the progress bar for the current plug-in.</p>
<p>Updates the progress bar for the current plug-in. It is only valid
to call this procedure from a plug-in. Use this function instead of
<a class="link" href="libgimp3-gimpprogress.html#gimp-progress-update" title="gimp_progress_update ()"><code class="function">gimp_progress_update()</code></a> if you cannot tell how much progress has been
made. This usually causes the the progress bar to enter \"activity
mode\", where a block bounces back and forth.</p>
<div class="refsect3">
<a name="gimp-progress-pulse.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-set-text"></a><h3>gimp_progress_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_set_text (<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>Changes the text in the progress bar for the current plug-in.</p>
<p>This function changes the text in the progress bar for the current
plug-in. Unlike <a class="link" href="libgimp3-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()"><code class="function">gimp_progress_init()</code></a> it does not change the
displayed value.</p>
<div class="refsect3">
<a name="gimp-progress-set-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>Message to use in the progress dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-progress-set-text.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-set-text-printf"></a><h3>gimp_progress_set_text_printf ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_set_text_printf (<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
                               <em class="parameter"><code>...</code></em>);</pre>
<p>Changes the text in the progress bar for the current plug-in.</p>
<p>This function changes the text in the progress bar for the current
plug-in. Unlike <a class="link" href="libgimp3-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()"><code class="function">gimp_progress_init()</code></a> it does not change the
displayed value.</p>
<div class="refsect3">
<a name="gimp-progress-set-text-printf.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a standard <code class="function">printf()</code> format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>arguments for <em class="parameter"><code>format</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-progress-set-text-printf.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-end"></a><h3>gimp_progress_end ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_end (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Ends the progress bar for the current plug-in.</p>
<p>Ends the progress display for the current plug-in. Most plug-ins
don't need to call this, they just exit when the work is done. It is
only valid to call this procedure from a plug-in.</p>
<div class="refsect3">
<a name="gimp-progress-end.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-get-window-handle"></a><h3>gimp_progress_get_window_handle ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_progress_get_window_handle (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the native window ID of the toplevel window this plug-in's
progress is displayed in.</p>
<p>This function returns the native window ID of the toplevel window
this plug-in\'s progress is displayed in.</p>
<div class="refsect3">
<a name="gimp-progress-get-window-handle.returns"></a><h4>Returns</h4>
<p> The progress bar's toplevel window.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-install-vtable"></a><h3>gimp_progress_install_vtable ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_progress_install_vtable (<em class="parameter"><code>const <a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtable" title="struct GimpProgressVtable"><span class="type">GimpProgressVtable</span></a> *vtable</code></em>,
                              <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
                              <em class="parameter"><code><span class="type">GDestroyNotify</span> user_data_destroy</code></em>);</pre>
<div class="refsect3">
<a name="gimp-progress-install-vtable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>vtable</p></td>
<td class="parameter_description"><p>a pointer to a <em class="parameter"><code>GimpProgressVtable</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>a pointer that is passed as user_data to all vtable
functions.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data_destroy</p></td>
<td class="parameter_description"><p>destroy function for <em class="parameter"><code>user_data</code></em>
, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-progress-install-vtable.returns"></a><h4>Returns</h4>
<p> the name of the temporary procedure that's been installed</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-uninstall"></a><h3>gimp_progress_uninstall ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_progress_uninstall (<em class="parameter"><code>const <span class="type">gchar</span> *progress_callback</code></em>);</pre>
<p>Uninstalls a temporary progress procedure that was installed using
<a href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimpprogress.html#gimp-progress-install"><code class="function">gimp_progress_install()</code></a>.</p>
<div class="refsect3">
<a name="gimp-progress-uninstall.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>progress_callback</p></td>
<td class="parameter_description"><p>the name of the temporary procedure to uninstall</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-cancel"></a><h3>gimp_progress_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_cancel (<em class="parameter"><code>const <span class="type">gchar</span> *progress_callback</code></em>);</pre>
<p>Cancels a running progress.</p>
<p>This function cancels the currently running progress.</p>
<div class="refsect3">
<a name="gimp-progress-cancel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>progress_callback</p></td>
<td class="parameter_description"><p>The name of the callback registered for this progress.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-progress-cancel.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpprogress.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GimpProgressVtable"></a><h3>struct GimpProgressVtable</h3>
<pre class="programlisting">struct GimpProgressVtable {
  GimpProgressVtableStartFunc     start;
  GimpProgressVtableEndFunc       end;
  GimpProgressVtableSetTextFunc   set_text;
  GimpProgressVtableSetValueFunc  set_value;
  GimpProgressVtablePulseFunc     pulse;
  GimpProgressVtableGetWindowFunc get_window;

  /* Padding for future expansion. Must be initialized with NULL! */
  void (* _gimp_reserved1) (void);
  void (* _gimp_reserved2) (void);
  void (* _gimp_reserved3) (void);
  void (* _gimp_reserved4) (void);
  void (* _gimp_reserved5) (void);
  void (* _gimp_reserved6) (void);
  void (* _gimp_reserved7) (void);
  void (* _gimp_reserved8) (void);
};
</pre>
<div class="refsect3">
<a name="GimpProgressVtable.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableStartFunc" title="GimpProgressVtableStartFunc ()"><span class="type">GimpProgressVtableStartFunc</span></a> <em class="structfield"><code><a name="GimpProgressVtable.start"></a>start</code></em>;</p></td>
<td class="struct_member_description"><p>starts the progress.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableEndFunc" title="GimpProgressVtableEndFunc ()"><span class="type">GimpProgressVtableEndFunc</span></a> <em class="structfield"><code><a name="GimpProgressVtable.end"></a>end</code></em>;</p></td>
<td class="struct_member_description"><p>ends the progress.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableSetTextFunc" title="GimpProgressVtableSetTextFunc ()"><span class="type">GimpProgressVtableSetTextFunc</span></a> <em class="structfield"><code><a name="GimpProgressVtable.set-text"></a>set_text</code></em>;</p></td>
<td class="struct_member_description"><p>sets a new text on the progress.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableSetValueFunc" title="GimpProgressVtableSetValueFunc ()"><span class="type">GimpProgressVtableSetValueFunc</span></a> <em class="structfield"><code><a name="GimpProgressVtable.set-value"></a>set_value</code></em>;</p></td>
<td class="struct_member_description"><p>sets a new percentage on the progress.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtablePulseFunc" title="GimpProgressVtablePulseFunc ()"><span class="type">GimpProgressVtablePulseFunc</span></a> <em class="structfield"><code><a name="GimpProgressVtable.pulse"></a>pulse</code></em>;</p></td>
<td class="struct_member_description"><p>makes the progress pulse.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libgimp3-gimpprogress.html#GimpProgressVtableGetWindowFunc" title="GimpProgressVtableGetWindowFunc ()"><span class="type">GimpProgressVtableGetWindowFunc</span></a> <em class="structfield"><code><a name="GimpProgressVtable.get-window"></a>get_window</code></em>;</p></td>
<td class="struct_member_description"><p>returns the ID of the window where the progress is displayed.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GimpProgressVtable.-gimp-reserved1"></a>_gimp_reserved1</code></em> ()</p></td>
<td class="struct_member_description"><p>reserved pointer for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GimpProgressVtable.-gimp-reserved2"></a>_gimp_reserved2</code></em> ()</p></td>
<td class="struct_member_description"><p>reserved pointer for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GimpProgressVtable.-gimp-reserved3"></a>_gimp_reserved3</code></em> ()</p></td>
<td class="struct_member_description"><p>reserved pointer for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GimpProgressVtable.-gimp-reserved4"></a>_gimp_reserved4</code></em> ()</p></td>
<td class="struct_member_description"><p>reserved pointer for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GimpProgressVtable.-gimp-reserved5"></a>_gimp_reserved5</code></em> ()</p></td>
<td class="struct_member_description"><p>reserved pointer for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GimpProgressVtable.-gimp-reserved6"></a>_gimp_reserved6</code></em> ()</p></td>
<td class="struct_member_description"><p>reserved pointer for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GimpProgressVtable.-gimp-reserved7"></a>_gimp_reserved7</code></em> ()</p></td>
<td class="struct_member_description"><p>reserved pointer for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GimpProgressVtable.-gimp-reserved8"></a>_gimp_reserved8</code></em> ()</p></td>
<td class="struct_member_description"><p>reserved pointer for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>